Video Translation (stable:2025-05-20)

2025/06/06 • 12 new methods

EventHubConfigurationOperations_GetEventHubConfiguration (new)
Description :  Get EventHub configuration.
Reference :  Link ¶

⚼ Request

GET:  /configurations/event-hub
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isEnabled:
{
Description: Indicate whether to enable sending event to EventHub. ,
Required: True ,
}
boolean ,
eventHubNamespaceHostName:
{
Description: EventHub namespace host name, for example: [YourNamespace].servicebus.windows.net ,
Required: True ,
}
string ,
eventHubName:
{
Description: EventHub name. ,
Required: True ,
}
string ,
managedIdentityClientId:
{
Description: Managed identity client ID for user-assigned managed identity, if not specified, API will use system-assigned managed identity. ,
Required: False ,
}
string ,
enabledEvents:
{
Description: Enabled event kinds for notification. ,
Required: True ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
EventHubConfigurationOperations_CreateOrReplaceEventHubConfiguration (new)
Description :  Create or replace EventHub configuration.
Reference :  Link ¶

⚼ Request

PUT:  /configurations/event-hub
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
isEnabled:
{
Description: Indicate whether to enable sending event to EventHub. ,
Required: True ,
}
boolean ,
eventHubNamespaceHostName:
{
Description: EventHub namespace host name, for example: [YourNamespace].servicebus.windows.net ,
Required: True ,
}
string ,
eventHubName:
{
Description: EventHub name. ,
Required: True ,
}
string ,
managedIdentityClientId:
{
Description: Managed identity client ID for user-assigned managed identity, if not specified, API will use system-assigned managed identity. ,
Required: False ,
}
string ,
enabledEvents:
{
Description: Enabled event kinds for notification. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
isEnabled:
{
Description: Indicate whether to enable sending event to EventHub. ,
Required: True ,
}
boolean ,
eventHubNamespaceHostName:
{
Description: EventHub namespace host name, for example: [YourNamespace].servicebus.windows.net ,
Required: True ,
}
string ,
eventHubName:
{
Description: EventHub name. ,
Required: True ,
}
string ,
managedIdentityClientId:
{
Description: Managed identity client ID for user-assigned managed identity, if not specified, API will use system-assigned managed identity. ,
Required: False ,
}
string ,
enabledEvents:
{
Description: Enabled event kinds for notification. ,
Required: True ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
EventHubConfigurationOperations_DeleteEventHubConfiguration (new)
Description :  Delete EventHub configuration.
Reference :  Link ¶

⚼ Request

DELETE:  /configurations/event-hub
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
EventHubConfigurationOperations_PingEventHub (new)
Description :  Send ping to EventHub to verify configuration.
Reference :  Link ¶

⚼ Request

POST:  /configurations/event-hub:ping
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
OperationOperations_GetOperation (new)
Description :  Fetch a operation by ID.
Reference :  Link ¶

⚼ Request

GET:  /operations/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Operation ID ,
Required: True ,
}
string ,
status:
{
Description: Operation status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TranslationOperations_ListTranslation (new)
Description :  List translation resources.
Reference :  Link ¶

⚼ Request

GET:  /translations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The Translation items on this page ,
Required: True ,
}
[
{
id:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
input:
{
Description: Translation input. ,
Required: True ,
}
{
sourceLocale:
{
Description: The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20. ,
Required: False ,
}
string ,
targetLocale:
{
Description: The target locale of the translation. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts. ,
Required: True ,
}
string ,
voiceKind:
{
Description: Translation voice kind. ,
Enum:
{
PlatformVoice: TTS platform voice ,
PersonalVoice: TTS personal voice ,
}
,
Required: True ,
}
enum ,
videoFileUrl:
{
Description: Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
audioFileUrl:
{
Description: Translation audio file Azure blob url, .mp3 or .wav file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
speakerCount:
{
Description: Number of speakers in the video, if not provided, it will be auto-detected from the video file. ,
Format: int32 ,
Required: False ,
}
integer ,
enableLipSync:
{
Description: Indicate whether to enable lip sync, if not provided, the default value is false to disable the lip sync. ,
Required: False ,
}
boolean ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not provided, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Translation display name. ,
Required: False ,
}
string ,
description:
{
Description: Translation description. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
latestIteration:
{
Description: Latest iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
latestSucceededIteration:
{
Description: Latest completed iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
failureReason:
{
Description: Translation failure reason ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TranslationOperations_GetTranslation (new)
Description :  Fetch a translation by ID.
Reference :  Link ¶

⚼ Request

GET:  /translations/{translationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
translationId:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
input:
{
Description: Translation input. ,
Required: True ,
}
{
sourceLocale:
{
Description: The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20. ,
Required: False ,
}
string ,
targetLocale:
{
Description: The target locale of the translation. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts. ,
Required: True ,
}
string ,
voiceKind:
{
Description: Translation voice kind. ,
Enum:
{
PlatformVoice: TTS platform voice ,
PersonalVoice: TTS personal voice ,
}
,
Required: True ,
}
enum ,
videoFileUrl:
{
Description: Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
audioFileUrl:
{
Description: Translation audio file Azure blob url, .mp3 or .wav file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
speakerCount:
{
Description: Number of speakers in the video, if not provided, it will be auto-detected from the video file. ,
Format: int32 ,
Required: False ,
}
integer ,
enableLipSync:
{
Description: Indicate whether to enable lip sync, if not provided, the default value is false to disable the lip sync. ,
Required: False ,
}
boolean ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not provided, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Translation display name. ,
Required: False ,
}
string ,
description:
{
Description: Translation description. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
latestIteration:
{
Description: Latest iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
latestSucceededIteration:
{
Description: Latest completed iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
failureReason:
{
Description: Translation failure reason ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TranslationOperations_CreateTranslation (new)
Description :  Creates a translation.
Reference :  Link ¶

⚼ Request

PUT:  /translations/{translationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
translationId:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
Operation-Id:
{
Description: Operation ID. ,
Required: True ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
id:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
input:
{
Description: Translation input. ,
Required: True ,
}
{
sourceLocale:
{
Description: The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20. ,
Required: False ,
}
string ,
targetLocale:
{
Description: The target locale of the translation. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts. ,
Required: True ,
}
string ,
voiceKind:
{
Description: Translation voice kind. ,
Enum:
{
PlatformVoice: TTS platform voice ,
PersonalVoice: TTS personal voice ,
}
,
Required: True ,
}
enum ,
videoFileUrl:
{
Description: Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
audioFileUrl:
{
Description: Translation audio file Azure blob url, .mp3 or .wav file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
speakerCount:
{
Description: Number of speakers in the video, if not provided, it will be auto-detected from the video file. ,
Format: int32 ,
Required: False ,
}
integer ,
enableLipSync:
{
Description: Indicate whether to enable lip sync, if not provided, the default value is false to disable the lip sync. ,
Required: False ,
}
boolean ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not provided, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Translation display name. ,
Required: False ,
}
string ,
description:
{
Description: Translation description. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
latestIteration:
{
Description: Latest iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
latestSucceededIteration:
{
Description: Latest completed iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
failureReason:
{
Description: Translation failure reason ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: Create translation resource for hosting iterations of translating one video file from source locale to target locale. ,
}
{
id:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
input:
{
Description: Translation input. ,
Required: True ,
}
{
sourceLocale:
{
Description: The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20. ,
Required: False ,
}
string ,
targetLocale:
{
Description: The target locale of the translation. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts. ,
Required: True ,
}
string ,
voiceKind:
{
Description: Translation voice kind. ,
Enum:
{
PlatformVoice: TTS platform voice ,
PersonalVoice: TTS personal voice ,
}
,
Required: True ,
}
enum ,
videoFileUrl:
{
Description: Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
audioFileUrl:
{
Description: Translation audio file Azure blob url, .mp3 or .wav file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
speakerCount:
{
Description: Number of speakers in the video, if not provided, it will be auto-detected from the video file. ,
Format: int32 ,
Required: False ,
}
integer ,
enableLipSync:
{
Description: Indicate whether to enable lip sync, if not provided, the default value is false to disable the lip sync. ,
Required: False ,
}
boolean ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not provided, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Translation display name. ,
Required: False ,
}
string ,
description:
{
Description: Translation description. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
latestIteration:
{
Description: Latest iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
latestSucceededIteration:
{
Description: Latest completed iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
failureReason:
{
Description: Translation failure reason ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: Create translation resource for hosting iterations of translating one video file from source locale to target locale. ,
}
{
id:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
input:
{
Description: Translation input. ,
Required: True ,
}
{
sourceLocale:
{
Description: The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20. ,
Required: False ,
}
string ,
targetLocale:
{
Description: The target locale of the translation. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts. ,
Required: True ,
}
string ,
voiceKind:
{
Description: Translation voice kind. ,
Enum:
{
PlatformVoice: TTS platform voice ,
PersonalVoice: TTS personal voice ,
}
,
Required: True ,
}
enum ,
videoFileUrl:
{
Description: Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
audioFileUrl:
{
Description: Translation audio file Azure blob url, .mp3 or .wav file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
speakerCount:
{
Description: Number of speakers in the video, if not provided, it will be auto-detected from the video file. ,
Format: int32 ,
Required: False ,
}
integer ,
enableLipSync:
{
Description: Indicate whether to enable lip sync, if not provided, the default value is false to disable the lip sync. ,
Required: False ,
}
boolean ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not provided, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Translation display name. ,
Required: False ,
}
string ,
description:
{
Description: Translation description. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
latestIteration:
{
Description: Latest iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
latestSucceededIteration:
{
Description: Latest completed iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
failureReason:
{
Description: Translation failure reason ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TranslationOperations_DeleteTranslation (new)
Description :  Delete a translation.
Reference :  Link ¶

⚼ Request

DELETE:  /translations/{translationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
translationId:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IterationOperations_ListIteration (new)
Description :  List Iteration resources.
Reference :  Link ¶

⚼ Request

GET:  /translations/{translationId}/iterations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
translationId:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The Iteration items on this page ,
Required: True ,
}
[
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IterationOperations_GetIteration (new)
Description :  Fetch a iteration by ID.
Reference :  Link ¶

⚼ Request

GET:  /translations/{translationId}/iterations/{iterationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
translationId:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
iterationId:
{
Description: Iteration ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IterationOperations_CreateIteration (new)
Description :  Creates an iteration.
Reference :  Link ¶

⚼ Request

PUT:  /translations/{translationId}/iterations/{iterationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
translationId:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
iterationId:
{
Description: Iteration ID ,
Required: True ,
}
string ,
Operation-Id:
{
Description: Operation ID. ,
Required: True ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: Do one iteration to translate one video file from source locale to target locale, webvtt for content editing is optional for requesting parameter. ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: Do one iteration to translate one video file from source locale to target locale, webvtt for content editing is optional for requesting parameter. ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
ttsCustomLexiconFileUrl:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: False ,
}
string ,
ttsCustomLexiconFileIdInAudioContentCreation:
{
Description: Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Required: False ,
}
string ,
enableVideoSpeedAdjustment:
{
Description: This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. ,
Required: False ,
}
boolean ,
enableOcrCorrectionFromSubtitle:
{
Description: Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. ,
Required: False ,
}
boolean ,
exportTargetLocaleAdvancedSubtitleFile:
{
Description: This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. ,
Required: False ,
}
boolean ,
subtitlePrimaryColor:
{
Description: This parameter specifies the primary color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default white color. ,
Required: False ,
}
string ,
subtitleOutlineColor:
{
Description: This parameter specifies the outline color of the subtitles in the video translation output. The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. This parameter allows for customization of subtitle appearance to enhance readability and visual appeal, if not specified, it will use default black color. ,
Required: False ,
}
string ,
subtitleFontSize:
{
Description: This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
enableEmotionalPlatformVoice:
{
Description: This parameter specifies whether to enable emotion for platform voice. By default, the server determines whether to apply emotion based on the target locale to optimize quality. If not specified, the API will automatically decide whether to enable emotional expression on the server side. ,
Enum:
{
Auto: Let API to decide whether to enable emotional voice for the target locale. ,
Enable: Force to enable emotional voice if there is voice supported emotion for the target locale. ,
Disable: Disable platform voice emotion for the target locale. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
translatedAudioFileUrl:
{
Description: Translated audio file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleAdvancedSubtitleFileUrl:
{
Description: This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}